<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>prencar: LiftCube Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  <td id="projectlogo"><img alt="Logo" src="prencar.png"/></td>
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">prencar
   &#160;<span id="projectnumber">1</span>
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.8.0 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('class_lift_cube.html','');
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Defines</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="#pri-static-attribs">Static Private Attributes</a>  </div>
  <div class="headertitle">
<div class="title">LiftCube Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="_lift_cube_8h_source.html">LiftCube.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for LiftCube:</div>
<div class="dyncontent">
<div class="center"><img src="class_lift_cube__coll__graph.png" border="0" usemap="#_lift_cube_coll__map" alt="Collaboration graph"/></div>
<map name="_lift_cube_coll__map" id="_lift_cube_coll__map">
<area shape="rect" id="node2" href="class_communication.html" title="Communication" alt="" coords="5,96,117,123"/><area shape="rect" id="node4" href="class_command.html" title="A Command object represents a command sent from the host software." alt="" coords="11,5,92,32"/><area shape="rect" id="node7" href="class_configuration.html" title="Configuration" alt="" coords="169,5,265,32"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="class_lift_cube-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ab5d1090dfcf43a319666d905b374d4a6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lift_cube.html#ab5d1090dfcf43a319666d905b374d4a6">doJob</a> ()</td></tr>
<tr class="memitem:a517b1b3c4dc314d228ba4dc79d17de64"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lift_cube.html#a517b1b3c4dc314d228ba4dc79d17de64">liftUp</a> ()</td></tr>
<tr class="memitem:a652d399235cafb5179a2d6c65df11112"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lift_cube.html#a652d399235cafb5179a2d6c65df11112">liftDown</a> ()</td></tr>
<tr class="memitem:a11c5c99c275d5a4acfc778852976f6cd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lift_cube.html#a11c5c99c275d5a4acfc778852976f6cd">liftCube</a> ()</td></tr>
<tr class="memitem:a6b6c013383282736029056541de33844"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lift_cube.html#a6b6c013383282736029056541de33844">setHoistPosition</a> (byte pos)</td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a7482caae31a755370d072f6ec85ad598"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_lift_cube.html">LiftCube</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lift_cube.html#a7482caae31a755370d072f6ec85ad598">getInstance</a> ()</td></tr>
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a7a13f30623f88cfa1de6437665854990"><td class="memItemLeft" align="right" valign="top">boolean&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lift_cube.html#a7a13f30623f88cfa1de6437665854990">cubeLifted</a></td></tr>
<tr class="memdesc:a7a13f30623f88cfa1de6437665854990"><td class="mdescLeft">&#160;</td><td class="mdescRight">Will be set to true as soon as the cube is lifted. If set to true the cube will not be lifted again automatically (a parcours restart is needed first).  <a href="#a7a13f30623f88cfa1de6437665854990"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:a5bf2f6939ce4578fbf54d9214dd91fb3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lift_cube.html#a5bf2f6939ce4578fbf54d9214dd91fb3">LiftCube</a> ()</td></tr>
<tr class="memitem:a9da2ca841910ad988f5b7e0313714968"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lift_cube.html#a9da2ca841910ad988f5b7e0313714968">begin</a> ()</td></tr>
<tr><td colspan="2"><h2><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a9626cc456176b07611aeefedf6fd8b48"><td class="memItemLeft" align="right" valign="top">byte&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lift_cube.html#a9626cc456176b07611aeefedf6fd8b48">_currentPosition</a></td></tr>
<tr class="memdesc:a9626cc456176b07611aeefedf6fd8b48"><td class="mdescLeft">&#160;</td><td class="mdescRight">Last position of the servo to which it was set (pwm value 0-255)  <a href="#a9626cc456176b07611aeefedf6fd8b48"></a><br/></td></tr>
<tr class="memitem:aeb1974f95c87f79df20161f44dd6c7bc"><td class="memItemLeft" align="right" valign="top">unsigned long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lift_cube.html#aeb1974f95c87f79df20161f44dd6c7bc">_liftDownStartTimestamp</a></td></tr>
<tr class="memdesc:aeb1974f95c87f79df20161f44dd6c7bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Saves the timestamp when the method liftCube is called to know when it's time to lift up again.  <a href="#aeb1974f95c87f79df20161f44dd6c7bc"></a><br/></td></tr>
<tr class="memitem:afb428580284ed0c38d6cf3745904d060"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_communication.html">Communication</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lift_cube.html#afb428580284ed0c38d6cf3745904d060">_com</a></td></tr>
<tr class="memdesc:afb428580284ed0c38d6cf3745904d060"><td class="mdescLeft">&#160;</td><td class="mdescRight">The reference to the serial communication class.  <a href="#afb428580284ed0c38d6cf3745904d060"></a><br/></td></tr>
<tr class="memitem:aea8e72092e201140adecaf04a98706d5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_configuration.html">Configuration</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lift_cube.html#aea8e72092e201140adecaf04a98706d5">_conf</a></td></tr>
<tr class="memdesc:aea8e72092e201140adecaf04a98706d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">The reference to the configuration class.  <a href="#aea8e72092e201140adecaf04a98706d5"></a><br/></td></tr>
<tr class="memitem:acfefe1c0364c233a5bf5e8b52bcab385"><td class="memItemLeft" align="right" valign="top">boolean&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lift_cube.html#acfefe1c0364c233a5bf5e8b52bcab385">_liftingStarted</a></td></tr>
<tr class="memdesc:acfefe1c0364c233a5bf5e8b52bcab385"><td class="mdescLeft">&#160;</td><td class="mdescRight">Will be set to true as soon as the cube lift process starts and will therefore prevent a second call to <a class="el" href="class_lift_cube.html#a11c5c99c275d5a4acfc778852976f6cd">liftCube()</a>.  <a href="#acfefe1c0364c233a5bf5e8b52bcab385"></a><br/></td></tr>
<tr class="memitem:ac1cad13e4bcc8f961b5ef642a685455b"><td class="memItemLeft" align="right" valign="top">Servo&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lift_cube.html#ac1cad13e4bcc8f961b5ef642a685455b">_hoistServo</a></td></tr>
<tr><td colspan="2"><h2><a name="pri-static-attribs"></a>
Static Private Attributes</h2></td></tr>
<tr class="memitem:a93b949abb4659fd6801c8b5c53d17f49"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_lift_cube.html">LiftCube</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lift_cube.html#a93b949abb4659fd6801c8b5c53d17f49">_instance</a></td></tr>
<tr class="memdesc:a93b949abb4659fd6801c8b5c53d17f49"><td class="mdescLeft">&#160;</td><td class="mdescRight">Static reference to the singleton object.  <a href="#a93b949abb4659fd6801c8b5c53d17f49"></a><br/></td></tr>
<tr class="memitem:a4cec38045e6a075620851c7c848c0584"><td class="memItemLeft" align="right" valign="top">static boolean&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lift_cube.html#a4cec38045e6a075620851c7c848c0584">_instanceCreated</a> = false</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock">
<p>Definition at line <a class="el" href="_lift_cube_8h_source.html#l00008">8</a> of file <a class="el" href="_lift_cube_8h_source.html">LiftCube.h</a>.</p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a5bf2f6939ce4578fbf54d9214dd91fb3"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_lift_cube.html#a5bf2f6939ce4578fbf54d9214dd91fb3">LiftCube::LiftCube</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Constructur for the class. </p>

<p>Definition at line <a class="el" href="_lift_cube_8cpp_source.html#l00030">30</a> of file <a class="el" href="_lift_cube_8cpp_source.html">LiftCube.cpp</a>.</p>

<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_lift_cube_a5bf2f6939ce4578fbf54d9214dd91fb3_icgraph.png" border="0" usemap="#class_lift_cube_a5bf2f6939ce4578fbf54d9214dd91fb3_icgraph" alt=""/></div>
<map name="class_lift_cube_a5bf2f6939ce4578fbf54d9214dd91fb3_icgraph" id="class_lift_cube_a5bf2f6939ce4578fbf54d9214dd91fb3_icgraph">
<area shape="rect" id="node3" href="class_lift_cube.html#a7482caae31a755370d072f6ec85ad598" title="LiftCube::getInstance" alt="" coords="179,5,323,32"/><area shape="rect" id="node5" href="class_lift_cube.html#a9da2ca841910ad988f5b7e0313714968" title="LiftCube::begin" alt="" coords="371,5,479,32"/></map>
</div>
</p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a9da2ca841910ad988f5b7e0313714968"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_lift_cube.html#a9da2ca841910ad988f5b7e0313714968">LiftCube::begin</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Prepares the <a class="el" href="class_lift_cube.html">LiftCube</a> object to work according to the values defined in the configuration. The preparations done in here can not be done from within the constructor because of dependencies such as Serial communication. <b>This method needs to be called before this class can be fully used.</b> In this class it is done when getting an instance of the class the first time. </p>
<dl class="section see"><dt>See also:</dt><dd><a class="el" href="class_lift_cube.html#a7482caae31a755370d072f6ec85ad598">getInstance()</a> </dd></dl>

<p>Definition at line <a class="el" href="_lift_cube_8cpp_source.html#l00043">43</a> of file <a class="el" href="_lift_cube_8cpp_source.html">LiftCube.cpp</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_lift_cube_a9da2ca841910ad988f5b7e0313714968_cgraph.png" border="0" usemap="#class_lift_cube_a9da2ca841910ad988f5b7e0313714968_cgraph" alt=""/></div>
<map name="class_lift_cube_a9da2ca841910ad988f5b7e0313714968_cgraph" id="class_lift_cube_a9da2ca841910ad988f5b7e0313714968_cgraph">
<area shape="rect" id="node3" href="class_lift_cube.html#a7482caae31a755370d072f6ec85ad598" title="LiftCube::getInstance" alt="" coords="163,5,307,32"/><area shape="rect" id="node5" href="class_lift_cube.html#a5bf2f6939ce4578fbf54d9214dd91fb3" title="LiftCube::LiftCube" alt="" coords="355,5,479,32"/></map>
</div>
</p>

<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_lift_cube_a9da2ca841910ad988f5b7e0313714968_icgraph.png" border="0" usemap="#class_lift_cube_a9da2ca841910ad988f5b7e0313714968_icgraph" alt=""/></div>
<map name="class_lift_cube_a9da2ca841910ad988f5b7e0313714968_icgraph" id="class_lift_cube_a9da2ca841910ad988f5b7e0313714968_icgraph">
<area shape="rect" id="node3" href="class_lift_cube.html#a7482caae31a755370d072f6ec85ad598" title="LiftCube::getInstance" alt="" coords="163,5,307,32"/></map>
</div>
</p>

</div>
</div>
<a class="anchor" id="ab5d1090dfcf43a319666d905b374d4a6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_lift_cube.html#ab5d1090dfcf43a319666d905b374d4a6">LiftCube::doJob</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Checks if it's already time to lift up the hoist again after <a class="el" href="class_lift_cube.html#a11c5c99c275d5a4acfc778852976f6cd">liftCube()</a> was called. This method has to be called in regular intervals (as short as possible).<br/>
 </p>

<p>Definition at line <a class="el" href="_lift_cube_8cpp_source.html#l00057">57</a> of file <a class="el" href="_lift_cube_8cpp_source.html">LiftCube.cpp</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_lift_cube_ab5d1090dfcf43a319666d905b374d4a6_cgraph.png" border="0" usemap="#class_lift_cube_ab5d1090dfcf43a319666d905b374d4a6_cgraph" alt=""/></div>
<map name="class_lift_cube_ab5d1090dfcf43a319666d905b374d4a6_cgraph" id="class_lift_cube_ab5d1090dfcf43a319666d905b374d4a6_cgraph">
<area shape="rect" id="node3" href="class_communication.html#a8679b3cb7ceef5527faa24454ce0f18a" title="Communication::send" alt="" coords="726,21,874,48"/><area shape="rect" id="node7" href="class_lift_cube.html#a11c5c99c275d5a4acfc778852976f6cd" title="LiftCube::liftCube" alt="" coords="165,33,285,60"/><area shape="rect" id="node15" href="class_lift_cube.html#a517b1b3c4dc314d228ba4dc79d17de64" title="LiftCube::liftUp" alt="" coords="341,123,448,149"/><area shape="rect" id="node5" href="class_configuration.html#ad398e1915b07ffc4091d4d5827bd6c6e" title="Configuration::getMessageFilterLevel" alt="" coords="923,21,1157,48"/><area shape="rect" id="node10" href="class_lift_cube.html#a652d399235cafb5179a2d6c65df11112" title="LiftCube::liftDown" alt="" coords="333,72,456,99"/><area shape="rect" id="node12" href="class_lift_cube.html#a6b6c013383282736029056541de33844" title="LiftCube::setHoistPosition" alt="" coords="505,72,677,99"/></map>
</div>
</p>

<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_lift_cube_ab5d1090dfcf43a319666d905b374d4a6_icgraph.png" border="0" usemap="#class_lift_cube_ab5d1090dfcf43a319666d905b374d4a6_icgraph" alt=""/></div>
<map name="class_lift_cube_ab5d1090dfcf43a319666d905b374d4a6_icgraph" id="class_lift_cube_ab5d1090dfcf43a319666d905b374d4a6_icgraph">
<area shape="rect" id="node3" href="class_state_maschine.html#a1095131aa8e6e9537f481b5f425395e2" title="StateMaschine::doJob" alt="" coords="166,5,317,32"/></map>
</div>
</p>

</div>
</div>
<a class="anchor" id="a7482caae31a755370d072f6ec85ad598"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_lift_cube.html">LiftCube</a> * <a class="el" href="class_lift_cube.html#a7482caae31a755370d072f6ec85ad598">LiftCube::getInstance</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Get the <a class="el" href="class_lift_cube.html">LiftCube</a> instance </p>
<dl class="section return"><dt>Returns:</dt><dd>Pointer to the <a class="el" href="class_lift_cube.html">LiftCube</a> instance </dd></dl>

<p>Definition at line <a class="el" href="_lift_cube_8cpp_source.html#l00013">13</a> of file <a class="el" href="_lift_cube_8cpp_source.html">LiftCube.cpp</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_lift_cube_a7482caae31a755370d072f6ec85ad598_cgraph.png" border="0" usemap="#class_lift_cube_a7482caae31a755370d072f6ec85ad598_cgraph" alt=""/></div>
<map name="class_lift_cube_a7482caae31a755370d072f6ec85ad598_cgraph" id="class_lift_cube_a7482caae31a755370d072f6ec85ad598_cgraph">
<area shape="rect" id="node3" href="class_lift_cube.html#a5bf2f6939ce4578fbf54d9214dd91fb3" title="LiftCube::LiftCube" alt="" coords="198,5,322,32"/><area shape="rect" id="node5" href="class_lift_cube.html#a9da2ca841910ad988f5b7e0313714968" title="LiftCube::begin" alt="" coords="206,56,314,83"/></map>
</div>
</p>

<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_lift_cube_a7482caae31a755370d072f6ec85ad598_icgraph.png" border="0" usemap="#class_lift_cube_a7482caae31a755370d072f6ec85ad598_icgraph" alt=""/></div>
<map name="class_lift_cube_a7482caae31a755370d072f6ec85ad598_icgraph" id="class_lift_cube_a7482caae31a755370d072f6ec85ad598_icgraph">
<area shape="rect" id="node3" href="class_lift_cube.html#a9da2ca841910ad988f5b7e0313714968" title="LiftCube::begin" alt="" coords="198,5,306,32"/></map>
</div>
</p>

</div>
</div>
<a class="anchor" id="a11c5c99c275d5a4acfc778852976f6cd"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_lift_cube.html#a11c5c99c275d5a4acfc778852976f6cd">LiftCube::liftCube</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Moves the hoist to the bottom position (according to the configuration), waits for the time defined in <a class="el" href="class_configuration.html#a3c887c3a7f7aa88ee549c81a62cf1c9c" title="Time in milliseconds between the liftDown and the liftUp command of the method LiftCube::liftCube()">Configuration::liftCubeDownUpDuration</a> and then moves the hoist to the top position again.<br/>
 <b>Make sure the doJob method is called in regular intervals.</b> </p>
<dl class="section see"><dt>See also:</dt><dd><a class="el" href="class_configuration.html#ac8a8b2bf842c6559c30c11436eff5c83" title="Pwm value to set if the hoist has to be moved up fully.">Configuration::liftCubeDownPosition</a> </dd>
<dd>
<a class="el" href="class_configuration.html#af6652efed17691fef4fa435e38c1642f" title="Pwm value to set if the hoist has to be moved up fully.">Configuration::liftCubeUpPosition</a> </dd>
<dd>
<a class="el" href="class_configuration.html#a3c887c3a7f7aa88ee549c81a62cf1c9c" title="Time in milliseconds between the liftDown and the liftUp command of the method LiftCube::liftCube()">Configuration::liftCubeDownUpDuration</a> </dd></dl>

<p>Definition at line <a class="el" href="_lift_cube_8cpp_source.html#l00100">100</a> of file <a class="el" href="_lift_cube_8cpp_source.html">LiftCube.cpp</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_lift_cube_a11c5c99c275d5a4acfc778852976f6cd_cgraph.png" border="0" usemap="#class_lift_cube_a11c5c99c275d5a4acfc778852976f6cd_cgraph" alt=""/></div>
<map name="class_lift_cube_a11c5c99c275d5a4acfc778852976f6cd_cgraph" id="class_lift_cube_a11c5c99c275d5a4acfc778852976f6cd_cgraph">
<area shape="rect" id="node3" href="class_communication.html#a8679b3cb7ceef5527faa24454ce0f18a" title="Communication::send" alt="" coords="566,5,714,32"/><area shape="rect" id="node7" href="class_lift_cube.html#a652d399235cafb5179a2d6c65df11112" title="LiftCube::liftDown" alt="" coords="173,31,296,57"/><area shape="rect" id="node5" href="class_configuration.html#ad398e1915b07ffc4091d4d5827bd6c6e" title="Configuration::getMessageFilterLevel" alt="" coords="763,5,997,32"/><area shape="rect" id="node9" href="class_lift_cube.html#a6b6c013383282736029056541de33844" title="LiftCube::setHoistPosition" alt="" coords="345,31,517,57"/></map>
</div>
</p>

<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_lift_cube_a11c5c99c275d5a4acfc778852976f6cd_icgraph.png" border="0" usemap="#class_lift_cube_a11c5c99c275d5a4acfc778852976f6cd_icgraph" alt=""/></div>
<map name="class_lift_cube_a11c5c99c275d5a4acfc778852976f6cd_icgraph" id="class_lift_cube_a11c5c99c275d5a4acfc778852976f6cd_icgraph">
<area shape="rect" id="node3" href="class_lift_cube.html#ab5d1090dfcf43a319666d905b374d4a6" title="LiftCube::doJob" alt="" coords="174,5,285,32"/><area shape="rect" id="node5" href="class_state_maschine.html#a1095131aa8e6e9537f481b5f425395e2" title="StateMaschine::doJob" alt="" coords="334,5,485,32"/></map>
</div>
</p>

</div>
</div>
<a class="anchor" id="a652d399235cafb5179a2d6c65df11112"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_lift_cube.html#a652d399235cafb5179a2d6c65df11112">LiftCube::liftDown</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Moves the hoist to the bottom position according to the configuration. </p>
<dl class="section see"><dt>See also:</dt><dd><a class="el" href="class_configuration.html#ac8a8b2bf842c6559c30c11436eff5c83" title="Pwm value to set if the hoist has to be moved up fully.">Configuration::liftCubeDownPosition</a> </dd></dl>

<p>Definition at line <a class="el" href="_lift_cube_8cpp_source.html#l00087">87</a> of file <a class="el" href="_lift_cube_8cpp_source.html">LiftCube.cpp</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_lift_cube_a652d399235cafb5179a2d6c65df11112_cgraph.png" border="0" usemap="#class_lift_cube_a652d399235cafb5179a2d6c65df11112_cgraph" alt=""/></div>
<map name="class_lift_cube_a652d399235cafb5179a2d6c65df11112_cgraph" id="class_lift_cube_a652d399235cafb5179a2d6c65df11112_cgraph">
<area shape="rect" id="node3" href="class_lift_cube.html#a6b6c013383282736029056541de33844" title="LiftCube::setHoistPosition" alt="" coords="177,5,349,32"/><area shape="rect" id="node5" href="class_communication.html#a8679b3cb7ceef5527faa24454ce0f18a" title="Communication::send" alt="" coords="398,5,546,32"/><area shape="rect" id="node7" href="class_configuration.html#ad398e1915b07ffc4091d4d5827bd6c6e" title="Configuration::getMessageFilterLevel" alt="" coords="595,5,829,32"/></map>
</div>
</p>

<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_lift_cube_a652d399235cafb5179a2d6c65df11112_icgraph.png" border="0" usemap="#class_lift_cube_a652d399235cafb5179a2d6c65df11112_icgraph" alt=""/></div>
<map name="class_lift_cube_a652d399235cafb5179a2d6c65df11112_icgraph" id="class_lift_cube_a652d399235cafb5179a2d6c65df11112_icgraph">
<area shape="rect" id="node3" href="class_lift_cube.html#a11c5c99c275d5a4acfc778852976f6cd" title="LiftCube::liftCube" alt="" coords="176,5,296,32"/><area shape="rect" id="node9" href="class_state_maschine.html#a5551d00a5224f595833b75969c2ca64a" title="StateMaschine::checkCommands" alt="" coords="344,56,563,83"/><area shape="rect" id="node5" href="class_lift_cube.html#ab5d1090dfcf43a319666d905b374d4a6" title="LiftCube::doJob" alt="" coords="398,5,509,32"/><area shape="rect" id="node7" href="class_state_maschine.html#a1095131aa8e6e9537f481b5f425395e2" title="StateMaschine::doJob" alt="" coords="611,31,762,57"/></map>
</div>
</p>

</div>
</div>
<a class="anchor" id="a517b1b3c4dc314d228ba4dc79d17de64"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_lift_cube.html#a517b1b3c4dc314d228ba4dc79d17de64">LiftCube::liftUp</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Moves the hoist to the top position according to the configuration. </p>
<dl class="section see"><dt>See also:</dt><dd><a class="el" href="class_configuration.html#af6652efed17691fef4fa435e38c1642f" title="Pwm value to set if the hoist has to be moved up fully.">Configuration::liftCubeUpPosition</a> </dd></dl>

<p>Definition at line <a class="el" href="_lift_cube_8cpp_source.html#l00078">78</a> of file <a class="el" href="_lift_cube_8cpp_source.html">LiftCube.cpp</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_lift_cube_a517b1b3c4dc314d228ba4dc79d17de64_cgraph.png" border="0" usemap="#class_lift_cube_a517b1b3c4dc314d228ba4dc79d17de64_cgraph" alt=""/></div>
<map name="class_lift_cube_a517b1b3c4dc314d228ba4dc79d17de64_cgraph" id="class_lift_cube_a517b1b3c4dc314d228ba4dc79d17de64_cgraph">
<area shape="rect" id="node3" href="class_lift_cube.html#a6b6c013383282736029056541de33844" title="LiftCube::setHoistPosition" alt="" coords="161,5,333,32"/><area shape="rect" id="node5" href="class_communication.html#a8679b3cb7ceef5527faa24454ce0f18a" title="Communication::send" alt="" coords="382,5,530,32"/><area shape="rect" id="node7" href="class_configuration.html#ad398e1915b07ffc4091d4d5827bd6c6e" title="Configuration::getMessageFilterLevel" alt="" coords="579,5,813,32"/></map>
</div>
</p>

<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_lift_cube_a517b1b3c4dc314d228ba4dc79d17de64_icgraph.png" border="0" usemap="#class_lift_cube_a517b1b3c4dc314d228ba4dc79d17de64_icgraph" alt=""/></div>
<map name="class_lift_cube_a517b1b3c4dc314d228ba4dc79d17de64_icgraph" id="class_lift_cube_a517b1b3c4dc314d228ba4dc79d17de64_icgraph">
<area shape="rect" id="node3" href="class_lift_cube.html#ab5d1090dfcf43a319666d905b374d4a6" title="LiftCube::doJob" alt="" coords="214,5,325,32"/><area shape="rect" id="node7" href="class_state_maschine.html#acdadfde97fc8449c816c1b489e2f4a22" title="StateMaschine::begin" alt="" coords="195,107,343,133"/><area shape="rect" id="node12" href="class_state_maschine.html#a5551d00a5224f595833b75969c2ca64a" title="StateMaschine::checkCommands" alt="" coords="160,56,379,83"/><area shape="rect" id="node5" href="class_state_maschine.html#a1095131aa8e6e9537f481b5f425395e2" title="StateMaschine::doJob" alt="" coords="443,31,594,57"/><area shape="rect" id="node9" href="class_state_maschine.html#a908a6b51448036bc23a7cd76acfcfbe0" title="StateMaschine::getInstance" alt="" coords="427,107,611,133"/></map>
</div>
</p>

</div>
</div>
<a class="anchor" id="a6b6c013383282736029056541de33844"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_lift_cube.html#a6b6c013383282736029056541de33844">LiftCube::setHoistPosition</a> </td>
          <td>(</td>
          <td class="paramtype">byte&#160;</td>
          <td class="paramname"><em>pos</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Moves the hoist to the given position (pwm value between 0-255). </p>

<p>Definition at line <a class="el" href="_lift_cube_8cpp_source.html#l00110">110</a> of file <a class="el" href="_lift_cube_8cpp_source.html">LiftCube.cpp</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_lift_cube_a6b6c013383282736029056541de33844_cgraph.png" border="0" usemap="#class_lift_cube_a6b6c013383282736029056541de33844_cgraph" alt=""/></div>
<map name="class_lift_cube_a6b6c013383282736029056541de33844_cgraph" id="class_lift_cube_a6b6c013383282736029056541de33844_cgraph">
<area shape="rect" id="node3" href="class_communication.html#a8679b3cb7ceef5527faa24454ce0f18a" title="Communication::send" alt="" coords="227,5,375,32"/><area shape="rect" id="node5" href="class_configuration.html#ad398e1915b07ffc4091d4d5827bd6c6e" title="Configuration::getMessageFilterLevel" alt="" coords="424,5,659,32"/></map>
</div>
</p>

<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_lift_cube_a6b6c013383282736029056541de33844_icgraph.png" border="0" usemap="#class_lift_cube_a6b6c013383282736029056541de33844_icgraph" alt=""/></div>
<map name="class_lift_cube_a6b6c013383282736029056541de33844_icgraph" id="class_lift_cube_a6b6c013383282736029056541de33844_icgraph">
<area shape="rect" id="node3" href="class_lift_cube.html#a517b1b3c4dc314d228ba4dc79d17de64" title="LiftCube::liftUp" alt="" coords="235,56,341,83"/><area shape="rect" id="node14" href="class_state_maschine.html#a5551d00a5224f595833b75969c2ca64a" title="StateMaschine::checkCommands" alt="" coords="397,107,616,133"/><area shape="rect" id="node17" href="class_lift_cube.html#a652d399235cafb5179a2d6c65df11112" title="LiftCube::liftDown" alt="" coords="227,157,349,184"/><area shape="rect" id="node5" href="class_lift_cube.html#ab5d1090dfcf43a319666d905b374d4a6" title="LiftCube::doJob" alt="" coords="701,157,811,184"/><area shape="rect" id="node9" href="class_state_maschine.html#acdadfde97fc8449c816c1b489e2f4a22" title="StateMaschine::begin" alt="" coords="433,5,581,32"/><area shape="rect" id="node7" href="class_state_maschine.html#a1095131aa8e6e9537f481b5f425395e2" title="StateMaschine::doJob" alt="" coords="897,132,1047,159"/><area shape="rect" id="node11" href="class_state_maschine.html#a908a6b51448036bc23a7cd76acfcfbe0" title="StateMaschine::getInstance" alt="" coords="664,5,848,32"/><area shape="rect" id="node19" href="class_lift_cube.html#a11c5c99c275d5a4acfc778852976f6cd" title="LiftCube::liftCube" alt="" coords="447,157,567,184"/></map>
</div>
</p>

</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="afb428580284ed0c38d6cf3745904d060"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_communication.html">Communication</a>* <a class="el" href="class_lift_cube.html#afb428580284ed0c38d6cf3745904d060">LiftCube::_com</a><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The reference to the serial communication class. </p>

<p>Definition at line <a class="el" href="_lift_cube_8h_source.html#l00018">18</a> of file <a class="el" href="_lift_cube_8h_source.html">LiftCube.h</a>.</p>

</div>
</div>
<a class="anchor" id="aea8e72092e201140adecaf04a98706d5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_configuration.html">Configuration</a>* <a class="el" href="class_lift_cube.html#aea8e72092e201140adecaf04a98706d5">LiftCube::_conf</a><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The reference to the configuration class. </p>

<p>Definition at line <a class="el" href="_lift_cube_8h_source.html#l00019">19</a> of file <a class="el" href="_lift_cube_8h_source.html">LiftCube.h</a>.</p>

</div>
</div>
<a class="anchor" id="a9626cc456176b07611aeefedf6fd8b48"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">byte <a class="el" href="class_lift_cube.html#a9626cc456176b07611aeefedf6fd8b48">LiftCube::_currentPosition</a><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Last position of the servo to which it was set (pwm value 0-255) </p>

<p>Definition at line <a class="el" href="_lift_cube_8h_source.html#l00015">15</a> of file <a class="el" href="_lift_cube_8h_source.html">LiftCube.h</a>.</p>

</div>
</div>
<a class="anchor" id="ac1cad13e4bcc8f961b5ef642a685455b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Servo <a class="el" href="class_lift_cube.html#ac1cad13e4bcc8f961b5ef642a685455b">LiftCube::_hoistServo</a><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="_lift_cube_8h_source.html#l00023">23</a> of file <a class="el" href="_lift_cube_8h_source.html">LiftCube.h</a>.</p>

</div>
</div>
<a class="anchor" id="a93b949abb4659fd6801c8b5c53d17f49"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_lift_cube.html">LiftCube</a> <a class="el" href="class_lift_cube.html#a93b949abb4659fd6801c8b5c53d17f49">LiftCube::_instance</a><code> [static, private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Static reference to the singleton object. </p>

<p>Definition at line <a class="el" href="_lift_cube_8h_source.html#l00012">12</a> of file <a class="el" href="_lift_cube_8h_source.html">LiftCube.h</a>.</p>

</div>
</div>
<a class="anchor" id="a4cec38045e6a075620851c7c848c0584"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">boolean <a class="el" href="class_lift_cube.html#a4cec38045e6a075620851c7c848c0584">LiftCube::_instanceCreated</a> = false<code> [static, private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="_lift_cube_8h_source.html#l00013">13</a> of file <a class="el" href="_lift_cube_8h_source.html">LiftCube.h</a>.</p>

</div>
</div>
<a class="anchor" id="aeb1974f95c87f79df20161f44dd6c7bc"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned long <a class="el" href="class_lift_cube.html#aeb1974f95c87f79df20161f44dd6c7bc">LiftCube::_liftDownStartTimestamp</a><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Saves the timestamp when the method liftCube is called to know when it's time to lift up again. </p>

<p>Definition at line <a class="el" href="_lift_cube_8h_source.html#l00016">16</a> of file <a class="el" href="_lift_cube_8h_source.html">LiftCube.h</a>.</p>

</div>
</div>
<a class="anchor" id="acfefe1c0364c233a5bf5e8b52bcab385"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">boolean <a class="el" href="class_lift_cube.html#acfefe1c0364c233a5bf5e8b52bcab385">LiftCube::_liftingStarted</a><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Will be set to true as soon as the cube lift process starts and will therefore prevent a second call to <a class="el" href="class_lift_cube.html#a11c5c99c275d5a4acfc778852976f6cd">liftCube()</a>. </p>

<p>Definition at line <a class="el" href="_lift_cube_8h_source.html#l00021">21</a> of file <a class="el" href="_lift_cube_8h_source.html">LiftCube.h</a>.</p>

</div>
</div>
<a class="anchor" id="a7a13f30623f88cfa1de6437665854990"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">boolean <a class="el" href="class_lift_cube.html#a7a13f30623f88cfa1de6437665854990">LiftCube::cubeLifted</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Will be set to true as soon as the cube is lifted. If set to true the cube will not be lifted again automatically (a parcours restart is needed first). </p>

<p>Definition at line <a class="el" href="_lift_cube_8h_source.html#l00027">27</a> of file <a class="el" href="_lift_cube_8h_source.html">LiftCube.h</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>D:/Workspace/Arduino/prencar/<a class="el" href="_lift_cube_8h_source.html">LiftCube.h</a></li>
<li>D:/Workspace/Arduino/prencar/<a class="el" href="_lift_cube_8cpp_source.html">LiftCube.cpp</a></li>
</ul>
</div><!-- contents -->
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="class_lift_cube.html">LiftCube</a>      </li>

    <li class="footer">Generated on Fri May 4 2012 09:56:54 for prencar by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.0 </li>
   </ul>
 </div>


</body>
</html>
